<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="TreeEvent,mx.events.TreeEvent,ITEM_CLOSE,ITEM_OPEN,ITEM_OPENING,animate,dispatchEvent,item,itemRenderer,opening,triggerEvent" name="keywords">
<title>mx.events.TreeEvent</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'TreeEvent - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/events/TreeEvent.html&amp;mx/events/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;TreeEvent</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class TreeEvent"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.events</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TreeEvent</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">TreeEvent <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../images/inherit-arrow.gif"> flash.events.Event</td>
</tr>
</table>
<p></p>
  The TreeEvent class represents the event object passed to the event
  listener for events that are associated with activities
  in tree, such as when a tree branch opens or closes.
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../controls/Tree.html" target="">mx.controls.Tree</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#animate">animate</a> : Boolean<div class="summaryTableDescription">
      Whether to animate an opening or closing operation; used for 
      ITEM_OPENING type events only.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dispatchEvent">dispatchEvent</a> : Boolean<div class="summaryTableDescription">
      Whether to dispatch an event (<code>ITEM_OPEN</code> or 
      <code>ITEM_CLOSE</code>) after the open or close animation 
      is complete.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#item">item</a> : Object<div class="summaryTableDescription">
      Storage for the item property.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#itemRenderer">itemRenderer</a> : <a href="../controls/listClasses/IListItemRenderer.html">IListItemRenderer</a>
<div class="summaryTableDescription">
      The ListItemRenderer for the node that closed or opened.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#opening">opening</a> : Boolean<div class="summaryTableDescription">
      Used for an <code>ITEM_OPENING</code> type events only.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#triggerEvent">triggerEvent</a> : Event<div class="summaryTableDescription">
      The low level MouseEvent or KeyboardEvent that triggered this
      event or <code>null</code> if this event was triggered programatically.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#TreeEvent()">TreeEvent</a>(type:String, bubbles:Boolean = false, cancelable:Boolean = false, item:Object = null, itemRenderer:<a href="../controls/listClasses/IListItemRenderer.html">IListItemRenderer</a> = null, triggerEvent:Event = null)</div>
<div class="summaryTableDescription">
      Constructor.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ITEM_CLOSE">ITEM_CLOSE</a> : String = "itemClose"<div class="summaryTableDescription">[static]
      The TreeEvent.ITEM_CLOSE event type constant indicates that a tree
      branch closed or collapsed.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ITEM_OPEN">ITEM_OPEN</a> : String = "itemOpen"<div class="summaryTableDescription">[static]
      The TreeEvent.ITEM_OPEN event type constant indicates that a tree
      branch opened or expanded.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ITEM_OPENING">ITEM_OPENING</a> : String = "itemOpening"<div class="summaryTableDescription">[static]
      The TreeEvent.ITEM_OPENING event type constant is dispatched immediately 
      before a tree opens or closes.</div>
</td><td class="summaryTableOwnerCol">TreeEvent</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="animate"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">animate</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var animate:Boolean</code><p>
      Whether to animate an opening or closing operation; used for 
      ITEM_OPENING type events only.
     </p></div>
<a name="dispatchEvent"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dispatchEvent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var dispatchEvent:Boolean</code><p>
      Whether to dispatch an event (<code>ITEM_OPEN</code> or 
      <code>ITEM_CLOSE</code>) after the open or close animation 
      is complete. Used for ITEM_OPENING type events only.
     </p></div>
<a name="item"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">item</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var item:Object</code><p>
      Storage for the item property.
      If you populate the Tree from XML data, access
      the properties for the node as
      <code>event.item.&64;<i>attribute_name</i></code>.
     </p></div>
<a name="itemRenderer"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">itemRenderer</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var itemRenderer:<a href="../controls/listClasses/IListItemRenderer.html">IListItemRenderer</a></code><p>
      The ListItemRenderer for the node that closed or opened.
     </p></div>
<a name="opening"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">opening</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var opening:Boolean</code><p>
      Used for an <code>ITEM_OPENING</code> type events only.
      Indicates whether the item 
      is opening <code>true</code>, or closing <code>false</code>.
     </p></div>
<a name="triggerEvent"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">triggerEvent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var triggerEvent:Event</code><p>
      The low level MouseEvent or KeyboardEvent that triggered this
      event or <code>null</code> if this event was triggered programatically.
     </p></div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="TreeEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">TreeEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function TreeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, item:Object = null, itemRenderer:<a href="../controls/listClasses/IListItemRenderer.html">IListItemRenderer</a> = null, triggerEvent:Event = null)</code><p>
      Constructor.
      Normally called by the Flex Tree control; not used in application code.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">type</span>:String</code> &mdash; The event type; indicates the action that caused the event.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">bubbles</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the event can bubble
      up the display list hierarchy.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">cancelable</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the behavior associated with the event
      can be prevented.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; The Tree node (item) to which this event applies.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">itemRenderer</span>:<a href="../controls/listClasses/IListItemRenderer.html">IListItemRenderer</a></code> (default = <code>null</code>)<code></code> &mdash; The item renderer object for the cell.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">triggerEvent</span>:Event</code> (default = <code>null</code>)<code></code> &mdash; If the node opened or closed in response to a
      user action, indicates the type of input action.
     </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="ITEM_CLOSE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ITEM_CLOSE</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ITEM_CLOSE:String = "itemClose"</code><p>
      The TreeEvent.ITEM_CLOSE event type constant indicates that a tree
      branch closed or collapsed.
           </p><p>The properties of the event object for this event type have the
      following values.
      Not all properties are meaningful for all kinds of events.
      See the detailed property descriptions for more information.</p>
     
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>itemRenderer</code></td>
             <td>The ListItemRenderer for the node that closed</td></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the
           event listener that handles the event. For example, if you use
           <code>myButton.addEventListener()</code> to register an event listener,
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>triggerEvent</code></td>
             <td>If the node closed in response to a user action,
                 identifies it as a keyboard action or a mouse action.</td></tr>
         <tr><td><code>item</code></td><td>the Tree item (node) that closed</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event;
           it is not always the Object listening for the event.
           Use the <code>currentTarget</code> property to always access the
           Object listening for the event.</td></tr>
         <tr><td><code>type</code></td><td>TreeEvent.ITEM_CLOSE</td></tr>
      </table>
           </div>
<a name="ITEM_OPEN"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ITEM_OPEN</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ITEM_OPEN:String = "itemOpen"</code><p>
      The TreeEvent.ITEM_OPEN event type constant indicates that a tree
      branch opened or expanded.
           </p><p>The properties of the event object for this event type have the
      following values.
      Not all properties are meaningful for all kinds of events.
      See the detailed property descriptions for more information.</p>
     
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>itemRenderer</code></td>
             <td>The ListItemRenderer for the item (node) that opened</td></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the
           event listener that handles the event. For example, if you use
           <code>myButton.addEventListener()</code> to register an event listener,
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>triggerEvent</code></td>
             <td>If the item (node) opened in response to a user action,
                 identifies it as a keyboard action or a mouse action.</td></tr>
         <tr><td><code>item</code></td><td>the Tree node that opened.</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event;
           it is not always the Object listening for the event.
           Use the <code>currentTarget</code> property to always access the
           Object listening for the event.</td></tr>
         <tr><td><code>type</code></td><td>TreeEvent.ITEM_OPEN</td></tr>
      </table>
           </div>
<a name="ITEM_OPENING"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ITEM_OPENING</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ITEM_OPENING:String = "itemOpening"</code><p>
      The TreeEvent.ITEM_OPENING event type constant is dispatched immediately 
      before a tree opens or closes.
           </p><p>The properties of the event object for this event type have the
      following values.
      Not all properties are meaningful for all kinds of events.
      See the detailed property descriptions for more information.</p>
     
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>animate</code></td><td>Whether to animate the opening 
                 or closing operation.</td></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>true</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the
                  event listener that handles the event. For example, if you use
                  <code>myButton.addEventListener()</code> to register an event
                  listener, myButton is the value of the <code>currentTarget</code>.</td></tr>
         <tr><td><code>dispatchEvent</code></td><td>Whether to dispatch an 
                 <code>ITEM_OPEN</code> or <code>ITEM_CLOSE</code> event
                  after the open or close animation is complete. true</td></tr>
         <tr><td><code>itemRenderer</code></td>
             <td>The ListItemRenderer for the item (node) that opened</td></tr>
         <tr><td><code>item</code></td><td>the Tree node that opened.</td></tr>
         <tr><td><code>opening</code></td><td>true if the item is opening, false
                 if it is closing.</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event;
           it is not always the Object listening for the event.
           Use the <code>currentTarget</code> property to always access the
           Object listening for the event.</td></tr>
         <tr><td><code>triggerEvent</code></td>
             <td>If the item opened in response to a user action,
                 identifies it as a keyboard action or a mouse action.</td></tr>
         <tr><td><code>type</code></td><td>TreeEvent.ITEM_OPENING</td></tr>
      </table>
           </div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
